Build Configuration File DTD

The build configuration DTD defines the format to which an build configuration file must conform.

<!-- 
   NXT Build Configuration dtd
   Version 1.1
   Copyright (c) 2005-2023, Rocket Software, Inc.
-->

<!ELEMENT publication (content-collection,document-filter*,root-document)>
<!ATTLIST publication
   version               CDATA   #FIXED "1.1"
   separator            CDATA    "\">

<!ELEMENT content-collection (indexsheet*)>
<!ATTLIST content-collection
   id            CDATA       #REQUIRED
   title         CDATA       #REQUIRED
   filename      CDATA       #REQUIRED
   encryption    (yes|no)    "no"
   compression   (none|fast|best) "none"
   password      CDATA       #IMPLIED
   stop-words    (yes|no)    "no"
   lang-module   CDATA       "NextPage US English Server Extension Module. Version 2.01">
<!-- Note: The encryption attribute is ignored in version 1.1-the presence of a password
 determines whether the collection in encrypted. -->

<!ELEMENT indexsheet EMPTY>
<!ATTLIST indexsheet
   id     CDATA #REQUIRED
   path   CDATA #REQUIRED>

<!ELEMENT root-document (rule,scoped-rule*,document*)>
<!ATTLIST root-document
   location   CDATA      #REQUIRED>

<!ELEMENT document (scoped-rule*,document*)>
<!ATTLIST document
   location   CDATA     #REQUIRED>

<!ELEMENT rule (property*)>
<!ATTLIST rule
   publish          (yes|no)      "yes"
   publish-content  (yes|no)      "yes"
   indexsheet       CDATA         #IMPLIED
   document-filter  CDATA         #IMPLIED>


<!ELEMENT scoped-rule (rule)>
<!ATTLIST scoped-rule
   document-type    CDATA         #IMPLIED
   extent      (Self|Descendants|Both) "Both">

<!ELEMENT property EMPTY>
<!ATTLIST property
   name   (content-type|encoding|hidden|id|unindexed|metadata|name|
title|unindexed|use-child-document|compression)         #REQUIRED
   source  CDATA         #REQUIRED
   value   CDATA         #REQUIRED>

<!ELEMENT document-filter (simple-property+)>
<!ATTLIST document-filter
   id      CDATA   #REQUIRED>

<!ELEMENT simple-property EMPTY>
<!ATTLIST simple-property
   name   CDATA   #REQUIRED
   value  CDATA   #REQUIRED>

Elements and Attributes

content-collection element

The content-collection element defines the content collection that NXT 4 creates or updates based on the configuration. The content-collection element has these attributes.

Attribute Description
id [Required] The ID of the content collection. This ID must be unique within the NXT 4 site that contains the content collection.
title [Required] The title of the content collection.
filename [Required] The complete path to the file that contains the content collection.
encryption Defines the encryption of the content collection. The value can be none, exportable, or best. The default is none.
compression Level at which to compress content collection data. You can specify none, fast, or best. The default is none. Specifying a higher compression level makes a content collection smaller but also makes it take longer to build. You should specify none for document types which are already compressed such as GIF and JPEG images.
password Specifies the password if you choose to protect the content collection.
stop-words Flag indicating whether or not to use stop words when indexing the content collection. The value can be yes or no. The default is no.
lang-module Name of the language module to use to create the content collection. The language module determines how the content collection's text is parsed and indexed. The default is NextPage US English Server Extension Module Version 2.01.

document element

The document element represents source documents and composes a configuration hierarchy that associates a publication rule with each descendant of the root source document. The document element has these attributes.

Attribute Description
location The location of this document in the source document hierarchy relative to its parent in the configuration hierarchy.

indexsheet element

The indexsheet element associates index sheets with the content collection. If you publish metadata with any of your documents, you must include an indexsheet with an ID of metadata. The indexsheet element has these attributes.

Attribute Description
id The ID of this indexsheet within the build configuration. The ID must be unique among all IDs in the build configuration.
path The complete path to the indexsheet.

property element

The property element defines a value for a destination document property. The property element has these attributes.

Attribute Description
name The destination property or metadata-property name.
source The general location associated with the source document for the property. Each data source has a well-defined set of sources.
value The specific location or value of the property.
default-source The value to use for source if the (source/value) pair fail to define a value for the property.
default-value The value to use for value if the (source/value) pair fail to define a value for the property.

publication element

The publication element defines the root of the configuration file. The publication element has these attributes.

Attribute Description
version The version of the configuration file. This must be 1.0.

root-document element

The root-document-element represents the source root document of the publication. It acts as the root of the configuration hierarchy that associates a publication rule with each descendant of the root source document. The root-document-element has these attributes.

Attribute Description
location The complete location reference of the source root document.

rule element

The rule element describes a transformation from a source document to a destination document that is part of a content collection. The rule element has these attributes.

Attribute Description
publish Determines whether or not this source document appears in the content collection. The value can be yes or no. Defaults to yes.
publish-content Determines whether or not to publish a document property for this source document. The value can be yes or no. Defaults to yes.
sort-order Defines the sort order for children of this source document. The value can be ascending, descending, or none. Defaults to none.
sort-property Defines the property or metadata property to use as the sort key if sort-order is ascending or descending.
indexsheet A reference to an indexsheet to use when indexing this source document. Must be a reference to an indexsheet that you defined using an indexsheet element.
document-filter Some data sources support modifying a source document before writing the document to the content collection. Each data source documents its support for this attribute.
metadata Each data source supports a different mechanism to associate metadata with the destination document. Each data source documents its support for this attribute.

scope element

The scope element limits the effect of a rule based on document type or hierarchy. The scope element has these attributes.

Attribute Description
document-type The document type to which this rule applies. Each data source documents how it defines document type. If this attribute is absent, the rule applies to all document types.
scope The value can be one of these:
self — Apply the rule to the source document.
descendants — Apply the rule to the descendants of the source document.
default — Apply the rule to both the source document and its descendants.

If you specify both document-type and scope, NXT 4 applies the rule to documents that satisfy both attributes. For example, if you specify document-type="xml" and scope="descendants", NXT 4 applies the rule to descendants of the source document that are XML documents.

simple-property element

The simple-property element defines one property within a simple-property-set element. The simple-property element has these attributes.

Attribute Description
name The name used to reference the property.
value The value of the referenced property.

simple-property-set element

You reference a simple-property-element as the metadata or document-filter attribute of a rule. Each datasource documents its format for these properties. The simple-property-element has these attributes.

Attribute Description
id The ID used to reference the simple-property-set within the configuration.

Copyright © 2005-2023, Rocket Software, Inc. All rights reserved.